Gobi Connection Mangement

Classes
struct	MinBasedImsi
struct	TrueImsi
struct	CdmaSystemInfo
struct	HdrSystemInfo
struct	GsmSystemInfo
struct	WcdmaSystemInfo
struct	LteSystemInfo
struct	TdscdmaSystemInfo
struct	HrpdPilot
struct	RxInfo
struct	TxInfo
struct	SWI_STRUCT_ServingSystem

Macros
#define	MAX_CDMA_SYS_INFO_MNC   3
#define	MAX_CDMA_SYS_INFO_MCC   3
#define	MAX_HDR_SYS_INFO_IS856SID   16
#define	MAX_GSM_SYS_INFO_MCC   3
#define	MAX_GSM_SYS_INFO_MNC   3
#define	MAX_WCDMA_SYS_INFO_MCC   3
#define	MAX_WCDMA_SYS_INFO_MNC   3
#define	MAX_LTE_SYS_INFO_MCC   3
#define	MAX_LTE_SYS_INFO_MNC   3
#define	MAX_TDSCDMA_SYS_INFO_MCC   3
#define	MAX_TDSCDMA_SYS_INFO_MNC   3
#define	MAX_MCC   3
#define	MAX_IMSI_11_12   2
#define	MAX_IMSI_S1   7
#define	MAX_IMSI_S2   3

Typedefs
typedef void(GOBICALLBACK *	tFNSessionState) (ULONG state, ULONG sessionEndReason)
typedef void(GOBICALLBACK *	tFNByteTotals) (ULONGLONG totalBytesTX, ULONGLONG totalBytesRX)
typedef void(GOBICALLBACK *	tFNDormancyStatus) (ULONG dormancyStatus)
typedef void(GOBICALLBACK *	tFNMobileIPStatus) (ULONG mipStatus)
typedef void(GOBICALLBACK *	tFNActivationStatus) (ULONG activationStatus)
typedef void(GOBICALLBACK *	tFNPower) (ULONG operatingMode)
typedef void(GOBICALLBACK *	tFNWirelessDisable) (ULONG bState)
typedef void(GOBICALLBACK *	tFNServingSystem) (BYTE registrationState, BYTE csAttachState, BYTE psAttachState, BYTE selectedNetwork, BYTE inUseRadioIfListNum, BYTE *pRadioIf)
typedef void(GOBICALLBACK *	tFNCurrentPlmn) (WORD mobileCountryCode, WORD mobileNetworkCode, BYTE networkDescriptionLength, CHAR *pNetworkDescription)
typedef void(GOBICALLBACK *	tFNSwiServingSystemInfo) (SWI_STRUCT_ServingSystem *pServingSystemInfo)
typedef void(GOBICALLBACK *	tFNDataCapabilities) (BYTE dataCapsSize, BYTE *pDataCaps)
typedef void(GOBICALLBACK *	tFNDataBearer) (ULONG dataBearer)
typedef void(GOBICALLBACK *	tFNRoamingIndicator) (ULONG roaming)
typedef void(GOBICALLBACK *	tFNSignalStrength) (INT8 signalStrength, ULONG radioInterface)
typedef void(GOBICALLBACK *	tFNRFInfo) (ULONG radioInterface, ULONG activeBandClass, ULONG activeChannel)
typedef void(GOBICALLBACK *	tFNLUReject) (ULONG serviceDomain, ULONG rejectCause)
typedef void(GOBICALLBACK *	tFNPLMNMode) (ULONG mode)
typedef void(GOBICALLBACK *	tFNNewSMS) (ULONG storageType, ULONG messageIndex)
typedef void(GOBICALLBACK *	tFNNewSMSCB) (BYTE ackIndicator, ULONG transactionId, BYTE format, USHORT length, BYTE *rawData)
typedef void(GOBICALLBACK *	tFNMsgWaitingCB) (BYTE numInstances, BYTE *msgType, BYTE *indStatus, BYTE *msgCount)
typedef void(GOBICALLBACK *	tFNNewNMEA) (LPCSTR pNMEA)
typedef void(GOBICALLBACK *	tFNPDSState) (ULONG enabledStatus, ULONG trackingStatus)
typedef void(GOBICALLBACK *	tFNCATEvent) (ULONG eventID, ULONG eventLen, BYTE *pEventData)
typedef void(GOBICALLBACK *	tFNOMADMAlert) (ULONG sessionType, USHORT sessionID)
typedef void(GOBICALLBACK *	tFNOMADMState) (ULONG sessionState, ULONG failureReason)
typedef void(GOBICALLBACK *	tFNDeviceRemoval) ()
typedef void(GOBICALLBACK *	tFNNetworkTime) (WORD m_year, BYTE m_month, BYTE m_day, BYTE m_hour, BYTE m_minute, BYTE m_second, BYTE m_dayOfWeek, BYTE m_timeZone, BYTE m_dayLightAdj)
typedef void(GOBICALLBACK *	tFNSystemSelectionPref) (BYTE *Mode)

Functions
IMPORTGOBI ULONG GOBICMAPI	QCWWAN2kEnumerateDevices (BYTE *pDevicesSize, BYTE *pDevices)
IMPORTGOBI ULONG GOBICMAPI	QCWWAN2kConnect (CHAR *pDeviceID, CHAR *pDeviceKey)
IMPORTGOBI ULONG GOBICMAPI	QCWWANConnect ()
IMPORTGOBI ULONG GOBICMAPI	QCWWANCancel ()
IMPORTGOBI ULONG GOBICMAPI	QCWWANDisconnect ()
IMPORTGOBI ULONG GOBICMAPI	QCWWAN2kGetConnectedDeviceID (ULONG deviceIDSize, CHAR *pDeviceID, ULONG deviceKeySize, CHAR *pDeviceKey)
IMPORTGOBI ULONG GOBICMAPI	QCWWANGetConnectedDeviceID (ULONG stringSize, CHAR *pString)

Detailed Description

Function Documentation

IMPORTGOBI ULONG GOBICMAPI QCWWAN2kConnect	(	CHAR *	pDeviceID,
		CHAR *	pDeviceKey
	)

This function connects the CM API library to the specified Gobi device

Parameters

pDeviceID	[ I ] - The device ID as reported by Windows
pDeviceKey	[ I ] - The device key (unique, stored on-device)

Returns

See GobiErrorCodes.h

IMPORTGOBI ULONG GOBICMAPI QCWWAN2kEnumerateDevices	(	BYTE *	pDevicesSize,
		BYTE *	pDevices
	)

This function enumerates the Gobi devices currently attached to the system

Parameters

pDevicesSize	[I/O] - Upon input the maximum number of elements that the device array can contain. Upon successful output the actual number of elements in the device array
pDevices	[ O ] - The device array

Returns

See GobiErrorCodes.h

IMPORTGOBI ULONG GOBICMAPI QCWWAN2kGetConnectedDeviceID	(	ULONG	deviceIDSize,
		CHAR *	pDeviceID,
		ULONG	deviceKeySize,
		CHAR *	pDeviceKey
	)

This function returns the ID/key of the device the Gobi CM API library is currently connected to

Parameters

deviceIDSize	[ I ] - The maximum number of characters (including NULL terminator) that the device ID array can contain
pDeviceID	[ O ] - Device ID (NULL terminated string)
deviceKeySize	[ I ] - The maximum number of characters (including NULL terminator) that the device key array can contain
pDeviceKey	[ O ] - Device key (NULL terminated string)

Returns

See GobiErrorCodes.h

IMPORTGOBI ULONG GOBICMAPI QCWWANCancel

(

)

This function cancels the most recent outstanding request

Returns

See GobiErrorCodes.h

IMPORTGOBI ULONG GOBICMAPI QCWWANConnect

(

)

QCWWANConnect (Deprecated)

This function connects the CM API library to the first Gobi device detected

Returns

See GobiErrorCodes.h

IMPORTGOBI ULONG GOBICMAPI QCWWANDisconnect

(

)

This function disconnects the CM API library from the currently connected Gobi device

Returns

See GobiErrorCodes.h

IMPORTGOBI ULONG GOBICMAPI QCWWANGetConnectedDeviceID	(	ULONG	stringSize,
		CHAR *	pString
	)

This function returns the ID of the deivce the Gobi CM API library is currently connected to

Parameters

stringSize	[ I ] - The maximum number of characters (including NULL terminator) that the string array can contain
pString	[ O ] - NULL terminated string

Returns

See GobiErrorCodes.h